/*
 * Copyright (c) 2011, Michael Bedward
 * 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this 
 * list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 */

package com.mousebender.gridfacade.vector;

import com.mousebender.gridfacade.GridViewCell;
import com.vividsolutions.jts.geom.Point;

import org.geotools.data.simple.SimpleFeatureCollection;
import org.geotools.geometry.jts.ReferencedEnvelope;

import org.opengis.filter.Filter;


/**
 * A grid view with a backing feature collection containing features with vector
 * geometry (point, line or polygon).
 * 
 * @author michael
 * 
 * @param <V> type of the values returned by this grid view
 */
public class PolygonGridView<V extends Number> extends FeatureCollectionGridView<V> {

    /**
     * Constructor. This is intended to be called by the {@linkplain GridViews} factory 
     * class rather than client code.
     * 
     * @param featureCollection
     * @param attributeName
     * @param bounds
     * @param cellXDim
     * @param cellYDim
     * @param outsideValue 
     */
    public PolygonGridView(SimpleFeatureCollection featureCollection,
            String attributeName, 
            ReferencedEnvelope bounds,
            double cellXDim, 
            double cellYDim, 
            V outsideValue) {
        
        super(featureCollection, attributeName, bounds, cellXDim, cellYDim, outsideValue);
    }

    /**
     * {@inheritDoc}
     * 
     * For {@code PolygonGridView} the filter test whether the cell's mid-point
     * intersects with the feature's polygon.
     * 
     */
    @Override
    protected Filter getFilter(GridViewCell cell) {
        Point p = GF.createPoint(cell.getCentreCoordinate());
        return FF.intersects(FF.property(geomAttributeName), FF.literal(p));
    }
    
}
